Class IPsecProcessImpl

All Implemented Interfaces:
IPCObject, IPsecProcess, Process

public class IPsecProcessImpl extends ProcessImpl implements IPsecProcess
Information provided by the PKI file:

    \class IpsecProcess
    
    \brief IpsecProcess is the process that handles IPSec.
    
    \example network().getDevice("Router0").getProcess("IpsecProcess")
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getGlobalLifeTime

      public int getGlobalLifeTime()
      Information provided by the PKI file:
      
          \brief Returns the global lifetime for encryption.
          
          \return int, the global lifetime for encryption.
          
              
      Specified by:
      getGlobalLifeTime in interface IPsecProcess
      Returns:
      int Returns a int
    • setGlobalLifeTime

      public void setGlobalLifeTime(int lifetime)
      Information provided by the PKI file:
      
          \brief Sets the global lifetime for encryption.
          
          \param lifetime, the global lifetime for encryption.
          
              
      Specified by:
      setGlobalLifeTime in interface IPsecProcess
      Parameters:
      lifetime - Takes in a parameter of lifetime
    • getCryptoMapSetCount

      public int getCryptoMapSetCount()
      Information provided by the PKI file:
      
          \brief Returns the number of crypto map sets.
          
          \return int, the number of crypto map sets.
          
              
      Specified by:
      getCryptoMapSetCount in interface IPsecProcess
      Returns:
      int Returns a int
    • getCryptoMapSetAt

      public CryptoMapSet getCryptoMapSetAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the crypto map set at the specified index.
          
          \param index, the index of the crypto map set of interest.
          
          \return CryptoMapSet, the CryptoMapSet object at the specified index.
          
              
      Specified by:
      getCryptoMapSetAt in interface IPsecProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      CryptoMapSet Returns a CryptoMapSet
    • addCryptoMapSetByNameSeq

      public void addCryptoMapSetByNameSeq(String name, int sequence)
      Information provided by the PKI file:
      
          \brief Adds a crypto map set with the specified name and sequence number.
          
          \param name, the name of the crypto map set.
          \param sequence, the sequence number of the crypto map set.
          
              
      Specified by:
      addCryptoMapSetByNameSeq in interface IPsecProcess
      Parameters:
      name - Takes in a parameter of name
      sequence - Takes in a parameter of sequence
    • getTransformSetCount

      public int getTransformSetCount()
      Information provided by the PKI file:
      
          \brief Returns the number of transform sets.
          
          \return int, the number of transform sets.
          
              
      Specified by:
      getTransformSetCount in interface IPsecProcess
      Returns:
      int Returns a int
    • getTransformSetAt

      public TransformSet getTransformSetAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the transform set at the specified index.
          
          \param index, the index of the transform set of interest.
          
          \return TransformSet, the TransformSet object at the specified index.
          
              
      Specified by:
      getTransformSetAt in interface IPsecProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      TransformSet Returns a TransformSet
    • getTransformSetbyName

      public TransformSet getTransformSetbyName(String name)
      Information provided by the PKI file:
      
          \brief Returns the transform set with the specified name.
          
          \param name, the name of the transform set of interest.
          
          \return TransformSet, the TransformSet object with the specified name.
          
              
      Specified by:
      getTransformSetbyName in interface IPsecProcess
      Parameters:
      name - Takes in a parameter of name
      Returns:
      TransformSet Returns a TransformSet
    • addTransformSetByName

      public void addTransformSetByName(String name)
      Information provided by the PKI file:
      
          \brief Adds a transform set with the specified name.
          
          \param name, the name for the transform set.
          
              
      Specified by:
      addTransformSetByName in interface IPsecProcess
      Parameters:
      name - Takes in a parameter of name
    • removeTransformSetByName

      public void removeTransformSetByName(String name)
      Information provided by the PKI file:
      
          \brief Removes the transform set with the specified name.
          
          \param name, the name for the transform set.
          
              
      Specified by:
      removeTransformSetByName in interface IPsecProcess
      Parameters:
      name - Takes in a parameter of name
    • isTransformSetUsedByMap

      public boolean isTransformSetUsedByMap(String name)
      Information provided by the PKI file:
      
          \brief Returns true if the specified transform set is used by the crypto map, otherwise false.
          
          \param name, the name of the transform set of interest.
          
          \return bool, true if the specified transform set is used by the crypto map, otherwise false.
          
              
      Specified by:
      isTransformSetUsedByMap in interface IPsecProcess
      Parameters:
      name - Takes in a parameter of name
      Returns:
      boolean Returns a boolean
    • getIkePolicyCount

      public int getIkePolicyCount()
      Information provided by the PKI file:
      
          \brief Returns the number of IKE policies.
          
          \return int, the number of IKE policies.
          
              
      Specified by:
      getIkePolicyCount in interface IPsecProcess
      Returns:
      int Returns a int
    • getIkePolicyAt

      public IkePolicy getIkePolicyAt(int index)
      Information provided by the PKI file:
      
          \brief Returns IKE policy at the specified index.
          
          \param index, the index of the IKE policy of interest.
          
          \return IkePolicy, the IkePolicy object at the specified index.
          
              
      Specified by:
      getIkePolicyAt in interface IPsecProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      IkePolicy Returns a IkePolicy
    • getTunnelGrpCount

      public int getTunnelGrpCount()
      Information provided by the PKI file:
      
          \brief Returns the number of Tunnel Group.
          
          \return int, the number of Tunnel Group.
          
              
      Specified by:
      getTunnelGrpCount in interface IPsecProcess
      Returns:
      int Returns a int
    • getTunnelGrpByName

      public TunnelGroup getTunnelGrpByName(String name)
      Information provided by the PKI file:
      
          \brief gets the tunnel group with the specified name.
          
          \param name, the name for the tunnelGroup.
          
              
      Specified by:
      getTunnelGrpByName in interface IPsecProcess
      Parameters:
      name - Takes in a parameter of name
      Returns:
      TunnelGroup Returns a TunnelGroup
    • addTunnelGrpByName

      public void addTunnelGrpByName(String name)
      Information provided by the PKI file:
      
          \brief Adds a Tunnel Group  with the specified name.
          
          \param name, the name for the Tunnel Group .
          
              
      Specified by:
      addTunnelGrpByName in interface IPsecProcess
      Parameters:
      name - Takes in a parameter of name
    • removeTunnelGrpByName

      public void removeTunnelGrpByName(String name)
      Information provided by the PKI file:
      
          \brief Removes the Tunnel Group with the specified name.
          
          \param name, the name for the Tunnel Group.
          
              
      Specified by:
      removeTunnelGrpByName in interface IPsecProcess
      Parameters:
      name - Takes in a parameter of name
    • getTunnelGrpAt

      public TunnelGroup getTunnelGrpAt(int index)
      Information provided by the PKI file:
      
          \brief Returns Tunnel Group at the specified index.
          
          \param index, the index of the Tunnel Group of interest.
          
          \return Tunnel Group, the Tunnel Group object at the specified index.
          
              
      Specified by:
      getTunnelGrpAt in interface IPsecProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      TunnelGroup Returns a TunnelGroup
    • getCryptoMapSetV6Count

      public int getCryptoMapSetV6Count()
      Information provided by the PKI file:
      
          \brief Returns the number of crypto map sets.
          
          \return int, the number of crypto map sets.
          
              
      Specified by:
      getCryptoMapSetV6Count in interface IPsecProcess
      Returns:
      int Returns a int
    • getCryptoMapSetV6At

      public CryptoMapSet getCryptoMapSetV6At(int index)
      Information provided by the PKI file:
      
          \brief Returns the crypto map set at the specified index.
          
          \param index, the index of the crypto map set of interest.
          
          \return CryptoMapSet, the CryptoMapSet object at the specified index.
          
              
      Specified by:
      getCryptoMapSetV6At in interface IPsecProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      CryptoMapSet Returns a CryptoMapSet
    • addCryptoMapSetByNameSeqV6

      public void addCryptoMapSetByNameSeqV6(String name, int sequence)
      Information provided by the PKI file:
      
          \brief Adds a crypto map set with the specified name and sequence number.
          
          \param name, the name of the crypto map set.
          \param sequence, the sequence number of the crypto map set.
          
              
      Specified by:
      addCryptoMapSetByNameSeqV6 in interface IPsecProcess
      Parameters:
      name - Takes in a parameter of name
      sequence - Takes in a parameter of sequence